<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Module pgsql_pool</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>

<h1>Module pgsql_pool</h1>
<ul class="index"><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>


<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#code_change-3">code_change/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#get_connection-1">get_connection/1</a></td><td>Get a db connection, wait at most ?PGSQL_CALL_TIMEOUT seconds before giving up.</td></tr>
<tr><td valign="top"><a href="#get_connection-2">get_connection/2</a></td><td>Get a db connection, wait at most Timeout seconds before giving up.</td></tr>
<tr><td valign="top"><a href="#get_database-1">get_database/1</a></td><td>Return the name of the database used for the pool.</td></tr>
<tr><td valign="top"><a href="#get_database_opt-2">get_database_opt/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#handle_call-3">handle_call/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#handle_cast-2">handle_cast/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr>
<tr><td valign="top"><a href="#return_connection-2">return_connection/2</a></td><td>Return a db connection back to the connection pool.</td></tr>
<tr><td valign="top"><a href="#start_link-2">start_link/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#start_link-3">start_link/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#status-1">status/1</a></td><td>Return the current status of the connection pool.</td></tr>
<tr><td valign="top"><a href="#stop-1">stop/1</a></td><td>Stop the pool, close all db connections.</td></tr>
<tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td></td></tr>
</table>

<h2><a name="functions">Function Details</a></h2>

<h3 class="function"><a name="code_change-3">code_change/3</a></h3>
<div class="spec">
<p><tt>code_change(OldVsn, State, Extra) -&gt; any()</tt></p>
</div>

<h3 class="function"><a name="get_connection-1">get_connection/1</a></h3>
<div class="spec">
<p><tt>get_connection(P) -&gt; any()</tt></p>
</div><p>Get a db connection, wait at most ?PGSQL_CALL_TIMEOUT seconds before giving up.</p>

<h3 class="function"><a name="get_connection-2">get_connection/2</a></h3>
<div class="spec">
<p><tt>get_connection(P, Timeout) -&gt; any()</tt></p>
</div><p>Get a db connection, wait at most Timeout seconds before giving up.</p>

<h3 class="function"><a name="get_database-1">get_database/1</a></h3>
<div class="spec">
<p><tt>get_database(P) -&gt; any()</tt></p>
</div><p>Return the name of the database used for the pool.</p>

<h3 class="function"><a name="get_database_opt-2">get_database_opt/2</a></h3>
<div class="spec">
<p><tt>get_database_opt(Opt, P) -&gt; any()</tt></p>
</div>

<h3 class="function"><a name="handle_call-3">handle_call/3</a></h3>
<div class="spec">
<p><tt>handle_call(Request, From, State) -&gt; any()</tt></p>
</div>

<h3 class="function"><a name="handle_cast-2">handle_cast/2</a></h3>
<div class="spec">
<p><tt>handle_cast(Request, State) -&gt; any()</tt></p>
</div>

<h3 class="function"><a name="handle_info-2">handle_info/2</a></h3>
<div class="spec">
<p><tt>handle_info(Info, State) -&gt; any()</tt></p>
</div>

<h3 class="function"><a name="init-1">init/1</a></h3>
<div class="spec">
<p><tt>init(X1) -&gt; any()</tt></p>
</div>

<h3 class="function"><a name="return_connection-2">return_connection/2</a></h3>
<div class="spec">
<p><tt>return_connection(P, C) -&gt; any()</tt></p>
</div><p>Return a db connection back to the connection pool.</p>

<h3 class="function"><a name="start_link-2">start_link/2</a></h3>
<div class="spec">
<p><tt>start_link(Size, Opts) -&gt; any()</tt></p>
</div>

<h3 class="function"><a name="start_link-3">start_link/3</a></h3>
<div class="spec">
<p><tt>start_link(Name, Size, Opts) -&gt; any()</tt></p>
</div>

<h3 class="function"><a name="status-1">status/1</a></h3>
<div class="spec">
<p><tt>status(P) -&gt; any()</tt></p>
</div><p>Return the current status of the connection pool.</p>

<h3 class="function"><a name="stop-1">stop/1</a></h3>
<div class="spec">
<p><tt>stop(P) -&gt; any()</tt></p>
</div><p>Stop the pool, close all db connections</p>

<h3 class="function"><a name="terminate-2">terminate/2</a></h3>
<div class="spec">
<p><tt>terminate(Reason, State) -&gt; any()</tt></p>
</div>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Feb 25 2011, 21:14:41.</i></p>
</body>
</html>
